Related articles * [X Keyboard Extension](/index.php/X_Keyboard_Extension "X Keyboard Extension") * [Console keyboard configuration](/index.php/Console_keyboard_configuration "Console keyboard configuration") * [Extra keyboard keys](/index.php/Extra_keyboard_keys "Extra keyboard keys") * [Xorg](/index.php/Xorg "Xorg") This article describes the basics of [Xorg](/index.php/Xorg "Xorg") keyboard configuration. For additional key mappings, see [Extra keyboard keys](/index.php/Extra_keyboard_keys "Extra keyboard keys"). ## Contents * [1 Keyboard layouts](#Keyboard_layouts) * [2 Viewing keyboard settings](#Viewing_keyboard_settings) * [2.1 Third party utilities](#Third_party_utilities) * [3 Setting keyboard layout](#Setting_keyboard_layout) * [3.1 Using setxkbmap](#Using_setxkbmap) * [3.2 Using X configuration files](#Using_X_configuration_files) * [3.2.1 Using localectl](#Using_localectl) * [4 Frequently used XKB options](#Frequently_used_XKB_options) * [4.1 Switching between keyboard layouts](#Switching_between_keyboard_layouts) * [4.2 Terminating Xorg with Ctrl+Alt+Backspace](#Terminating_Xorg_with_Ctrl.2BAlt.2BBackspace) * [4.3 Swapping Caps Lock with Left Control](#Swapping_Caps_Lock_with_Left_Control) * [4.4 Enabling mouse keys](#Enabling_mouse_keys) * [4.5 Configuring compose key](#Configuring_compose_key) * [4.5.1 Key combinations](#Key_combinations) * [4.6 Currency sign on other key](#Currency_sign_on_other_key) * [4.7 Switching state immediately when Caps Lock is pressed](#Switching_state_immediately_when_Caps_Lock_is_pressed) * [4.7.1 Workaround](#Workaround) * [5 Adjusting typematic delay and rate](#Adjusting_typematic_delay_and_rate) * [5.1 Using xset](#Using_xset) * [5.2 Using XServer startup options](#Using_XServer_startup_options) * [5.3 Using XServer options](#Using_XServer_options) * [6 Identifying keycodes](#Identifying_keycodes) * [7 Keybinding](#Keybinding) * [7.1 Third-party tools](#Third-party_tools) * [7.1.1 sxhkd](#sxhkd) * [7.1.2 actkbd](#actkbd) * [7.1.3 xbindkeys](#xbindkeys) * [8 See also](#See_also) ## Keyboard layouts In Xorg keyboard layouts are defined using [X Keyboard Extension](/index.php/X_Keyboard_Extension "X Keyboard Extension") (XKB). You can set the XKB keyboard layout with [setxkbmap(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/setxkbmap.1). [xmodmap](/index.php/Xmodmap "Xmodmap") can be used to directly access the internal keymap table, although this is not recommended for complex tasks. Also [systemd](/index.php/Systemd "Systemd")'s [localectl(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/localectl.1) can be used to define the keyboard layout for both the Xorg server and the virtual console. ## Viewing keyboard settings You can use the following command to see the actual XKB settings: `$ setxkbmap -print -verbose 10` ``` Setting verbose level to 10 locale is C Applied rules from evdev: model: evdev layout: us options: terminate:ctrl_alt_bksp Trying to build keymap using the following components: keycodes: evdev+aliases(qwerty) types: complete compat: complete symbols: pc+us+inet(evdev)+terminate(ctrl_alt_bksp) geometry: pc(pc104) xkb_keymap { xkb_keycodes { include "evdev+aliases(qwerty)" }; xkb_types { include "complete" }; xkb_compat { include "complete" }; xkb_symbols { include "pc+us+inet(evdev)+terminate(ctrl_alt_bksp)" }; xkb_geometry { include "pc(pc104)" }; }; ``` ### Third party utilities There are some "unofficial" utilities which allow to print specific information about the currently used keyboard layout. * [xkb-switch-git](https://aur.archlinux.org/packages/xkb-switch-git/): `$ xkb-switch` `us` * [xkblayout-state](https://aur.archlinux.org/packages/xkblayout-state/): `$ xkblayout-state print "%s"` `de` ## Setting keyboard layout Keyboard layout in Xorg can be set in multiple ways. Here is an explanation of used options: * `XkbModel` selects the keyboard model. This has an influence only for some extra keys your keyboard might have. The safe fallback are `pc104` or `pc105`. But for instance laptops usually have some extra keys, and sometimes you can make them work by simply setting a proper model. * `XkbLayout` selects the keyboard layout. Multiple layouts may be specified in a comma-separated list, e.g. if you want to quickly switch between layouts. * `XkbVariant` selects a specific layout variant. For instance, the default `sk` variant is `qwertz`, but you can manually specify `qwerty`, etc. * `XkbOptions` contains some extra options. Used for specifying layout switching, notification LED, compose mode etc. See the [#Frequently used XKB options](#Frequently_used_XKB_options) section for examples. **Note:** You must specify as many variants as the number of specified layouts. If you want the default variant, specify an empty string as the variant (the comma must stay). For example, to have the default `us` layout as primary and the `dvorak` variant of `us` layout as secondary, specify `us,us` as `XkbLayout` and `,dvorak` as `XkbVariant`. The layout name is usually a [2-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements "wikipedia:ISO 3166-1 alpha-2"). To see a full list of keyboard models, layouts, variants and options, along with a short description, open `/usr/share/X11/xkb/rules/base.lst`. Alternatively, you may use one of the following commands to see a list without a description: * `localectl list-x11-keymap-models` * `localectl list-x11-keymap-layouts` * `localectl list-x11-keymap-variants [*layout*]` * `localectl list-x11-keymap-options` Examples in the following subsections will have the same effect, they will set `pc104` model, `cz` as primary layout, `us` as secondary layout, `dvorak` variant for `us` layout and the `Alt+Shift` combination for switching between layouts. See [xkeyboard-config(7)](https://jlk.fjfi.cvut.cz/arch/manpages/man/xkeyboard-config.7) for more detailed information. ### Using setxkbmap *setxkbmap* sets the keyboard layout for the current X session only, but can be made persistent in [xinitrc](/index.php/Xinitrc "Xinitrc") or [xprofile](/index.php/Xprofile "Xprofile"). This overrides system-wide configuration specified following [#Using X configuration files](#Using_X_configuration_files). The usage is as follows (see [setxkbmap(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/setxkbmap.1)): ``` $ setxkbmap [-model *xkb_model*] [-layout *xkb_layout*] [-variant *xkb_variant*] [-option *xkb_options*] ``` To change just the layout (`-layout` is the default flag): ``` $ setxkbmap *xkb_layout* ``` For multiple customizations: ``` $ setxkbmap -model pc104 -layout cz,us -variant ,dvorak -option grp:alt_shift_toggle ``` ### Using X configuration files **Note:** `xorg.conf` is parsed by the X server at start-up. To apply changes, restart X. The syntax of X configuration files is explained in [Xorg#Configuration](/index.php/Xorg#Configuration "Xorg"). This method creates system-wide configuration which is persistent across reboots. Here is an example: `/etc/X11/xorg.conf.d/00-keyboard.conf` ``` Section "InputClass" Identifier "system-keyboard" MatchIsKeyboard "on" Option "XkbLayout" "cz,us" Option "XkbModel" "pc104" Option "XkbVariant" ",dvorak" Option "XkbOptions" "grp:alt_shift_toggle" EndSection ``` #### Using localectl For convenience, the tool *localectl* may be used instead of manually editing X configuration files. It will save the configuration in `/etc/X11/xorg.conf.d/00-keyboard.conf`, this file should not be manually edited, because *localectl* will overwrite the changes on next start. The usage is as follows: ``` $ localectl [--no-convert] set-x11-keymap *layout* [*model* [*variant* [*options*]]] ``` To set a *model*, *variant* or *options*, all preceding fields need to be specified, but the preceding fields can be skipped by passing an empty string with `""`. Unless the `--no-convert` option is passed, the specified keymap is also converted to the closest matching console keymap and applied to the [console configuration](/index.php/Console_keyboard_configuration "Console keyboard configuration") in `vconsole.conf`. See [localectl(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/localectl.1) for more information. To create a `/etc/X11/xorg.conf.d/00-keyboard.conf` like the above: ``` $ localectl --no-convert set-x11-keymap cz,us pc104 ,dvorak grp:alt_shift_toggle ``` ## Frequently used XKB options ### Switching between keyboard layouts To be able to easily switch keyboard layouts, first specify multiple layouts between which you want to switch (the first one is the default). Then specify a key (or key combination), which will be used for switching. For example, to switch between a US and a Swedish layout using the `CapsLock` key, use `us,se` as an argument of `XkbLayout` and `grp:caps_toggle` as an argument of `XkbOptions`. You can use other key combinations than `CapsLock`, they are listed in `/usr/share/X11/xkb/rules/base.lst`, start with `grp:` and end with `toggle`. To get the full list of available options, run the following command: ``` $ grep "grp:.*toggle" /usr/share/X11/xkb/rules/base.lst ``` ### Terminating Xorg with Ctrl+Alt+Backspace By default, the key combination `Ctrl+Alt+Backspace` is disabled. You can enable it by passing `terminate:ctrl_alt_bksp` to `XkbOptions`. This can also be done by binding a key to `Terminate_Server` in `xmodmap` (which undoes any existing `XkbOptions` setting). In order for either method to work, one also needs to have `DontZap` set to "off" in `ServerFlags`; however, from at least version R6.8.0 (year 2004) [[1]](https://www.x.org/archive/X11R6.8.0/doc/xorg.conf.5.html) this is the default. ### Swapping Caps Lock with Left Control To swap Caps Lock with Left Control key, add `ctrl:swapcaps` to `XkbOptions`. Run the following command to see similar options along with their descriptions: ``` $ grep -E "(ctrl|caps):" /usr/share/X11/xkb/rules/base.lst ``` ### Enabling mouse keys [Mouse keys](https://en.wikipedia.org/wiki/Mouse_keys "w:Mouse keys") is disabled by default and has to be manually enabled by passing `keypad:pointerkeys` to `XkbOptions`. This will make the `Shift+NumLock` shortcut toggle mouse keys. See also [X Keyboard Extension#Mouse control](/index.php/X_Keyboard_Extension#Mouse_control "X Keyboard Extension") for advanced configuration. ### Configuring compose key Though typically not on traditional keyboards, a [Compose key](https://en.wikipedia.org/wiki/Compose_key "wikipedia:Compose key") can be configured to an existent key. The `Compose` key begins a keypress sequence that involves (usually two) additional keypresses. Usage is typically either for entering characters in a language that the keyboard was not designed for, or for other less-used characters that are not covered with the `AltGr` modifier. For example, pressing `Compose` `'` `e` produces `é`, or `Compose` `-` `-` will produce an "em dash": `—`. Though a few more eccentric keyboards feature a `Compose` key, its availability is usually through substituting an already existing key to it. For example, to make the `Menu` key a `Compose` key use the [Desktop environment](/index.php/Desktop_environment "Desktop environment") configuration, or pass `compose:menu` to `XkbOptions` (or [setxkbmap](#Using_setxkbmap): `setxkbmap -option compose:menu`). Allowed key substitutions are defined in `/usr/share/X11/xkb/rules/base.lst`: ``` $ grep "compose:" /usr/share/X11/xkb/rules/base.lst ``` If the desired mapping is not found in that file, an alternative is to use [xmodmap](/index.php/Xmodmap "Xmodmap") to map the desired key to the `Multi_key` keysym, which acts as a compose key by default (note that *xmodmap* settings are reset by *setxkbmap*). #### Key combinations The default combinations for the compose keys depend on the [locale](/index.php/Locale "Locale") configured for the session and are stored in `/usr/share/X11/locale/*used_locale*/Compose`, where `*used_locale*` is for example `en_US.UTF-8`. You can define your own compose key combinations by copying the default file to `~/.XCompose` and editing it. The compose key works with any of the thousands of valid Unicode characters, including those outside the Basic Multilingual Plane. Take a look at the [Compose(5)](https://jlk.fjfi.cvut.cz/arch/manpages/man/Compose.5) man page, it explains the format of the XCompose files. However, GTK does not use [XIM](https://en.wikipedia.org/wiki/X_Input_Method "wikipedia:X Input Method") by default and therefore does not follow `~/.XCompose` keys. This can be fixed by forcing GTK to use XIM by adding `export GTK_IM_MODULE=xim` and/or `export XMODIFIERS="@im=none"` to `~/.xprofile`. **Tip:** XIM is very old, you might have better luck with other input methods: [SCIM](/index.php/SCIM "SCIM"), [UIM](/index.php/UIM "UIM"), [IBus](/index.php/IBus "IBus"), etc. See [Internationalization#Input methods in Xorg](/index.php/Internationalization#Input_methods_in_Xorg "Internationalization") for details. **Note:** XIM will prevent insertion of Unicode characters with the `Ctrl+Shift+u` combination. ### Currency sign on other key Most European keyboards have a Euro sign (€) printed on on the `5` key. For example, to access it with `Alt+5`, use the `lv3:lalt_switch` and `eurosign:5` options. The Rupee sign (₹) can be used the same way with `rupeesign:4`. ### Switching state immediately when Caps Lock is pressed Those who prefer typing capital letters with the Caps Lock key may experience a short delay when Caps Lock state is switched, resulting in two or more capital letters (e.g. *THe*, *ARch LInux*). This behaviour [stems from typewriters](https://en.wikipedia.org/wiki/Caps_lock#History "wikipedia:Caps lock"). Some more popular operating systems have removed this behaviour, either voluntarily (as it can be confusing to some) or by mistake, however this is a question of preference. Bug reports have been filed on the Xserver bug tracker, as there is currently no easy way to switch to the behaviour reflected by those other operating systems. For anyone who would like to follow up the issue, bug reports and latest working progress can be found at [[2]](https://bugs.freedesktop.org/show_bug.cgi?id=27903) and [[3]](https://bugs.freedesktop.org/show_bug.cgi?id=56491). #### Workaround First, export your keyboard configurations to a file: ``` $ xkbcomp -xkb $DISPLAY xkbmap ``` In the file *xkbmap*, locate the Caps Lock section which begins with *key *: ``` key { [ Caps_Lock ] }; ``` and replace whole section with the following code: ``` key { repeat=no, type[group1]="ALPHABETIC", symbols[group1]=[ Caps_Lock, Caps_Lock], actions[group1]=[ LockMods(modifiers=Lock), Private(type=3,data[0]=1,data[1]=3,data[2]=3)] }; ``` Save and reload keyboard configurations: ``` $ xkbcomp -w 0 xkbmap $DISPLAY ``` Consider making it a service launching after X starts, since reloaded configurations do not survive a system reboot. ## Adjusting typematic delay and rate The *typematic delay* indicates the amount of time (typically in miliseconds) a key needs to be pressed and held in order for the repeating process to begin. After the repeating process has been triggered, the character will be repeated with a certain frequency (usually given in Hz) specified by the *typematic rate*. Note that these settings are configured seperately for Xorg and [for the virtual console](/index.php/Console_keyboard_configuration#Adjusting_typematic_delay_and_rate "Console keyboard configuration"). ### Using xset The tool *xset* can be used to set the typematic delay and rate for an active X server, certain actions during runtime tho may cause the XServer to reset these changes and revert instead to its *seat defaults*. Usage: ``` $ xset r rate *delay* [*rate*] ``` For example to set a typematic delay to 200ms and a typematic rate to 30Hz, use the following command (use [xinitrc](/index.php/Xinitrc "Xinitrc") to make it permanent): ``` $ xset r rate 200 30 ``` Issuing the command without specifying the delay and rate will reset the typematic values to their respective defaults; a delay of 660ms and a rate of 25Hz: ``` $ xset r rate ``` ### Using XServer startup options A more resistant way to set the typematic delay and rate is to make them the *seat defaults* by passing the desired settings to the X server on its startup using the following options: * `-ardelay *miliseconds*` - sets the autorepeat delay (length of time in milliseconds that a key must be depressed before autorepeat starts). * `-arinterval *miliseconds*` - sets the autorepeat interval (length of time in milliseconds that should elapse between autorepeat-generated keystrokes). See [Xserver(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/Xserver.1) for a full list of X server options and refer to your [display manager](/index.php/Display_manager "Display manager") for information about how to pass these options. ### Using XServer options Add this line to `/etc/X11/xorg.conf.d/00-keyboard.conf`: ``` Option "AutoRepeat" "*delay* *rate*" ``` ## Identifying keycodes **Note:** The Xorg [keycodes](/index.php/Keyboard_input "Keyboard input") are 8 larger than the Linux keycodes.[[4]](https://cgit.freedesktop.org/xorg/driver/xf86-input-evdev/tree/src/evdev.c) The *keycodes* used by [Xorg](/index.php/Xorg "Xorg") are reported by a utility called [xev(1)](https://jlk.fjfi.cvut.cz/arch/manpages/man/xev.1), which is provided by the [xorg-xev](https://www.archlinux.org/packages/?name=xorg-xev) package. Of course to execute *xev*, you need to be in a graphical environment, not in the console. With the following command you can start *xev* and show only the relevant parts: ``` $ xev | awk -F'[ )]+' '/^KeyPress/ { a[NR+2] } NR in a { printf "%-3s %s ", $5, $8 }' ``` Here is an example output: ``` 38 a 55 v 54 c 50 Shift_L 133 Super_L 135 Menu ``` [Xbindkeys#Identifying keycodes](/index.php/Xbindkeys#Identifying_keycodes "Xbindkeys") is another wrapper to "xev" that reports keycodes. If you press a key and nothing appears in the terminal, it means that either the key does not have a *scancode*, the *scancode* is not mapped to a *keycode*, or some other process is capturing the keypress. If you suspect that a process listening to X server is capturing the keypress, you can try running xev from a clean X session: ``` $ xinit /usr/bin/xterm -- :1 ``` ## Keybinding When we are in a graphical environment we may want to execute a command when certain key combination is pressed (i.e. bind a command to a keysym). There are multiple ways to do that: * The most portable way using low level tools, such as [acpid](/index.php/Acpid "Acpid"). Not all keys are supported, but configuration in uniform way is possible for keyboard keys, power adapter connection and even headphone jack (un)plugging events. It is also difficult to run programs inside X session correctly. * The universal way using [Xorg](/index.php/Xorg "Xorg") utilities (e.g. [xbindkeys](/index.php/Xbindkeys "Xbindkeys")) and eventually your desktop environment or window manager tools. * The quicker way using a third-party program to do everything in GUI, such as the Gnome Control Center or [Keytouch](/index.php/Keytouch "Keytouch"). ### Third-party tools #### sxhkd A simple X hotkey daemon with a powerful and compact configuration syntax. See [sxhkd](/index.php/Sxhkd "Sxhkd") for details. #### actkbd From [actkbd home page](http://users.softlab.ece.ntua.gr/~thkala/projects/actkbd/): [actkbd](https://aur.archlinux.org/packages/actkbd/) (available in [AUR](/index.php/AUR "AUR")) is a simple daemon that binds actions to keyboard events. It recognises key combinations and can handle press, repeat and release events. Currently it only supports the linux-2.6 evdev interface. It uses a plain-text configuration file which contains all the bindings. A sample configuration and guide is available [here](http://users.softlab.ece.ntua.gr/~thkala/projects/actkbd/latest/README). #### xbindkeys [xbindkeys](/index.php/Xbindkeys "Xbindkeys") allows advanced mapping of keysyms to actions independently of the Desktop Environment. **Tip:** If you find `xbindkeys` difficult to use, try the graphical manager [xbindkeys_config-gtk2](https://aur.archlinux.org/packages/xbindkeys_config-gtk2/) from the [AUR](/index.php/AUR "AUR"). ## See also * [Madduck guide on extending XKB](http://madduck.net/docs/extending-xkb/)